<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>buffers_iterator</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="buffers_end.html" title="buffers_end">
<link rel="next" href="buffers_iterator/begin.html" title="buffers_iterator::begin">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buffers_end.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="buffers_iterator/begin.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.buffers_iterator"></a><a class="link" href="buffers_iterator.html" title="buffers_iterator">buffers_iterator</a>
</h3></div></div></div>
<p>
        A random access iterator over the bytes in a buffer sequence.
      </p>
<pre class="programlisting">template&lt;
    typename BufferSequence,
    typename ByteType = char&gt;
class buffers_iterator
</pre>
<h5>
<a name="asio.reference.buffers_iterator.h0"></a>
        <span><a name="asio.reference.buffers_iterator.types"></a></span><a class="link" href="buffers_iterator.html#asio.reference.buffers_iterator.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/difference_type.html" title="buffers_iterator::difference_type"><span class="bold"><strong>difference_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type used for the distance between two iterators.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/iterator_category.html" title="buffers_iterator::iterator_category"><span class="bold"><strong>iterator_category</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The iterator category.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/pointer.html" title="buffers_iterator::pointer"><span class="bold"><strong>pointer</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type of the result of applying operator-&gt;() to the iterator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/reference.html" title="buffers_iterator::reference"><span class="bold"><strong>reference</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type of the result of applying operator*() to the iterator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/value_type.html" title="buffers_iterator::value_type"><span class="bold"><strong>value_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type of the value pointed to by the iterator.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.buffers_iterator.h1"></a>
        <span><a name="asio.reference.buffers_iterator.member_functions"></a></span><a class="link" href="buffers_iterator.html#asio.reference.buffers_iterator.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/begin.html" title="buffers_iterator::begin"><span class="bold"><strong>begin</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Construct an iterator representing the beginning of the buffers'
                  data.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/buffers_iterator.html" title="buffers_iterator::buffers_iterator"><span class="bold"><strong>buffers_iterator</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Default constructor. Creates an iterator in an undefined state.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/end.html" title="buffers_iterator::end"><span class="bold"><strong>end</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Construct an iterator representing the end of the buffers' data.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator__star_.html" title="buffers_iterator::operator *"><span class="bold"><strong>operator *</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Dereference an iterator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_plus__plus_.html" title="buffers_iterator::operator++"><span class="bold"><strong>operator++</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Increment operator (prefix). <br> <span class="silver"> &#8212;</span><br> Increment operator (postfix).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_plus__eq_.html" title="buffers_iterator::operator+="><span class="bold"><strong>operator+=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Addition operator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_minus__minus_.html" title="buffers_iterator::operator--"><span class="bold"><strong>operator--</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Decrement operator (prefix). <br> <span class="silver"> &#8212;</span><br> Decrement operator (postfix).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_minus__eq_.html" title="buffers_iterator::operator-="><span class="bold"><strong>operator-=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Subtraction operator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_arrow_.html" title="buffers_iterator::operator-&gt;"><span class="bold"><strong>operator-&gt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Dereference an iterator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_lb__rb_.html" title="buffers_iterator::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Access an individual element.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.buffers_iterator.h2"></a>
        <span><a name="asio.reference.buffers_iterator.friends"></a></span><a class="link" href="buffers_iterator.html#asio.reference.buffers_iterator.friends">Friends</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_not__eq_.html" title="buffers_iterator::operator!="><span class="bold"><strong>operator!=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Test two iterators for inequality.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_plus_.html" title="buffers_iterator::operator+"><span class="bold"><strong>operator+</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Addition operator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_minus_.html" title="buffers_iterator::operator-"><span class="bold"><strong>operator-</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Subtraction operator.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_lt_.html" title="buffers_iterator::operator&lt;"><span class="bold"><strong>operator&lt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two iterators.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_lt__eq_.html" title="buffers_iterator::operator&lt;="><span class="bold"><strong>operator&lt;=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two iterators.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_eq__eq_.html" title="buffers_iterator::operator=="><span class="bold"><strong>operator==</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Test two iterators for equality.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_gt_.html" title="buffers_iterator::operator&gt;"><span class="bold"><strong>operator&gt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two iterators.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="buffers_iterator/operator_gt__eq_.html" title="buffers_iterator::operator&gt;="><span class="bold"><strong>operator&gt;=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two iterators.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.buffers_iterator.h3"></a>
        <span><a name="asio.reference.buffers_iterator.requirements"></a></span><a class="link" href="buffers_iterator.html#asio.reference.buffers_iterator.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/buffers_iterator.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buffers_end.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="buffers_iterator/begin.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
